﻿// --------------------------------------------------------------------------------------------------------------------
// <copyright file="MacroPropertyAttribute.cs" company="CodePlex">
//   The MIT License
//   Copyright (c) 2013 Julien Blin
//   
//   Permission is hereby granted, free of charge, to any person obtaining a copy
//   of this software and associated documentation files (the "Software"), to deal
//   in the Software without restriction, including without limitation the rights
//   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//   copies of the Software, and to permit persons to whom the Software is
//   furnished to do so, subject to the following conditions:
//   
//   The above copyright notice and this permission notice shall be included in
//   all copies or substantial portions of the Software.
//   
//   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//   THE SOFTWARE.
// </copyright>
// --------------------------------------------------------------------------------------------------------------------

namespace UCodeFirst.Macros
{
    using System;

    using UCodeFirst.Converters;

    /// <summary>
    /// Mark a property as being a macro parameter.
    /// </summary>
    [AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = true)]
    public class MacroPropertyAttribute : NameAttributeBase
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="MacroPropertyAttribute"/> class.
        /// </summary>
        /// <param name="macroParameterType">
        /// The macro parameter type.
        /// </param>
        public MacroPropertyAttribute(MacroParameterType macroParameterType)
        {
            this.MacroParameterType = macroParameterType;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="MacroPropertyAttribute"/> class.
        /// </summary>
        /// <param name="macroParameterTypeAlias">
        /// The macro parameter type alias.
        /// </param>
        public MacroPropertyAttribute(string macroParameterTypeAlias)
        {
            this.MacroParameterTypeAlias = macroParameterTypeAlias;
        }

        /// <summary>
        /// Gets the macro parameter type.
        /// </summary>
        public MacroParameterType MacroParameterType { get; private set; }

        /// <summary>
        /// Gets the macro parameter type alias.
        /// </summary>
        public string MacroParameterTypeAlias { get; private set; }

        /// <summary>
        /// Gets or sets the custom converter. If not specified, will try to use a standard converter.
        /// The converter must implement <see cref="IConverter"/>.
        /// </summary>
        public Type Converter { get; set; }

        /// <summary>
        /// Returns the final macro parameter type alias, either
        /// <see cref="MacroParameterType"/> or <see cref="MacroParameterTypeAlias"/>.
        /// </summary>
        /// <returns>
        /// The alias.
        /// </returns>
        internal string GetMacroParameterTypeAlias()
        {
            return string.IsNullOrEmpty(this.MacroParameterTypeAlias)
                ? this.MacroParameterType.ToString().FirstCharacterToLower()
                : this.MacroParameterTypeAlias;
        }
    }
}
